Documento operativo - Raccomandazioni di implementazione¶
Indice dei contenuti
- 1. Introduzione
- 2. Ambito di applicazione
- 3. Riferimenti e sigle
- 4. Raccomandazioni tecniche generali
- 4.1. Raccomandazioni globali
- 4.2. Raccomandazioni sul formato dei dati
- 4.2.1. [RAC_GEN_FORMAT_001] Utilizzare Content-Type semanticamente coerenti
- 4.2.2. [RAC_GEN_FORMAT_002] Evitare Content-Type personalizzati
- 4.2.3. [RAC_GEN_FORMAT_003] Formati standard per Data ed Ora
- 4.2.4. [RAC_GEN_FORMAT_004] Tempi di durata e intervalli
- 4.2.5. [RAC_GEN_FORMAT_005] Lingue e monete
- 4.3. Raccomandazioni sulla progettazione e naming
- 4.4. Raccomandazioni sul logging
- 4.5. Raccomandazioni sulla robustezza
- 5. Raccomandazioni tecniche per REST
- 5.1. Raccomandazioni sul formato dei dati
- 5.1.1. [RAC_REST_FORMAT_001] Utilizzo oggetti JSON
- 5.1.2. [RAC_REST_FORMAT_002] Codificare dati strutturati con oggetti JSON
- 5.1.3. [RAC_REST_FORMAT_003] Convenzioni di rappresentazione
- 5.1.4. [RAC_REST_FORMAT_004] Definire format quando si usano i tipi Number ed Integer
- 5.1.5. [RAC_REST_FORMAT_005] Usare link relations registrate
- 5.2. Raccomandazioni su progettazione e naming
- 5.2.1. [RAC_REST_NAME_001] Uso corretto dei metodi HTTP
- 5.2.2. [RAC_REST_NAME_002] Usare parole separate da trattino «-» per i path (kebab-case)
- 5.2.3. [RAC_REST_NAME_003] Preferire Hyphenated-Pascal-Case per gli header HTTP
- 5.2.4. [RAC_REST_NAME_004] Le collezioni di risorse possono usare nomi al plurale
- 5.2.5. [RAC_REST_NAME_005] Utilizzare Query String standardizzate
- 5.2.6. [RAC_REST_NAME_006] Non passare tramite l’header Link informazioni fornite nella response JSON
- 5.2.7. [RAC_REST_NAME_007] Usare URI assoluti nei risultati
- 5.2.8. [RAC_REST_NAME_008] Usare lo schema Problem JSON per le risposte di errore
- 5.2.9. [RAC_REST_NAME_009] Ottimizzare l’uso della banda e migliorare la responsività
- 5.2.10. [RAC_REST_NAME_010] Il caching http deve essere disabilitato
- 5.2.11. [RAC_REST_NAME_011] Esporre lo stato del servizio
- 5.1. Raccomandazioni sul formato dei dati
- 6. Raccomandazioni tecniche per SOAP
- 7. Gestione degli allegati